<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <title>ihold</title>
    <link rel="stylesheet" type="text/css" href="csound.css" />
    <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" />
    <link rel="home" href="index.html" title="The Canonical Csound Reference Manual" />
    <link rel="up" href="OpcodesTop.html" title="Orchestra Opcodes and Operators" />
    <link rel="prev" href="igoto.html" title="igoto" />
    <link rel="next" href="imagecreate.html" title="imagecreate" />
  </head>
  <body>
    <div class="navheader">
      <table width="100%" summary="Navigation header">
        <tr>
          <th colspan="3" align="center">ihold</th>
        </tr>
        <tr>
          <td width="20%" align="left"><a accesskey="p" href="igoto.html">Prev</a> </td>
          <th width="60%" align="center">Orchestra Opcodes and Operators</th>
          <td width="20%" align="right"> <a accesskey="n" href="imagecreate.html">Next</a></td>
        </tr>
      </table>
      <hr />
    </div>
    <div class="refentry">
      <a id="ihold"></a>
      <div class="titlepage"></div>
      <a id="IndexIhold" class="indexterm"></a>
      <div class="refnamediv">
        <h2>
          <span class="refentrytitle">ihold</span>
        </h2>
        <p>ihold — 
      Creates a held note.
          </p>
      </div>
      <div class="refsect1">
        <a id="idp115447680"></a>
        <h2>Description</h2>
        <p>
      Causes a finite-duration note to become a <span class="quote">“<span class="quote">held</span>”</span> note
    </p>
      </div>
      <div class="refsect1">
        <a id="idp115449344"></a>
        <h2>Syntax</h2>
        <pre class="synopsis">
          <span class="command">
            <strong>ihold</strong>
          </span>
        </pre>
      </div>
      <div class="refsect1">
        <a id="idp115451264"></a>
        <h2>Performance</h2>
        <p>
      <span class="emphasis"><em>ihold</em></span> -- this i-time statement causes a finite-duration note to become a <span class="quote">“<span class="quote">held</span>”</span> note. It thus has the same effect as a negative p3 ( see score <a class="link" href="i.html" title="i Statement (Instrument or Note Statement)"><em class="citetitle">i Statement</em></a>), except that p3 here remains positive and the instrument reclassifies itself to being held indefinitely. The note can be turned off explicitly with <span class="emphasis"><em>turnoff</em></span>, or its space taken over by another note of the same instrument number (i.e. it is tied into that note). Effective at i-time only; no-op during a <span class="emphasis"><em>reinit</em></span> pass.
    </p>
      </div>
      <div class="refsect1">
        <a id="idp115455472"></a>
        <h2>Examples</h2>
        <p>
      Here is an example of the ihold opcode. It uses the file <a class="ulink" href="examples/ihold.csd" target="_top"><em class="citetitle">ihold.csd</em></a>.

      </p>
        <div class="example">
          <a id="idp115457328"></a>
          <p class="title">
            <strong>Example 384. Example of the ihold opcode.</strong>
          </p>
          <div class="example-contents">
            <p>See the sections <a class="link" href="UsingRealTime.html" title="Real-Time Audio"><em class="citetitle">Real-time Audio</em></a> and <a class="link" href="CommandFlags.html" title="Csound command line"><em class="citetitle">Command Line Flags</em></a> for more information on using command line flags.</p>
            <pre class="programlisting">
<span class="csdtag">&lt;CsoundSynthesizer&gt;</span>
<span class="csdtag">&lt;CsOptions&gt;</span>
<span class="comment">; Select audio/midi flags here according to platform</span>
<span class="comment">; Audio out   Audio in    No messages</span>
-odac           -iadc     -d     <span class="comment">;;;RT audio I/O</span>
<span class="comment">; For Non-realtime ouput leave only the line below:</span>
<span class="comment">; -o ihold.wav -W ;;; for file output any platform</span>
<span class="csdtag">&lt;/CsOptions&gt;</span>
<span class="csdtag">&lt;CsInstruments&gt;</span>

<span class="comment">; Initialize the global variables.</span>
<span class="ohdr">sr</span> <span class="op">=</span> 44100
<span class="ohdr">kr</span> <span class="op">=</span> 4410
<span class="ohdr">ksmps</span> <span class="op">=</span> 10
<span class="ohdr">nchnls</span> <span class="op">=</span> 1

<span class="comment">; Instrument #1.</span>
<span class="oblock">instr</span> 1
  <span class="comment">; A simple oscillator with its note held indefinitely.</span>
  a1 <span class="opc">oscil</span> 10000, 440, 1
  <span class="opc">ihold</span>

  <span class="comment">; If p4 equals 0, turn the note off.</span>
  <span class="octrl">if</span> (p4 <span class="op">==</span> 0) <span class="octrl">kgoto</span> <span class="olabel">offnow</span>
    <span class="octrl">kgoto</span> <span class="olabel">playit</span>

<span class="olabel">offnow</span><span class="op">:</span>
  <span class="comment">; Turn the note off now.</span>
  <span class="opc">turnoff</span>

<span class="olabel">playit</span><span class="op">:</span>
  <span class="comment">; Play the note.</span>
  <span class="opc">out</span> a1
<span class="oblock">endin</span>


<span class="csdtag">&lt;/CsInstruments&gt;</span>
<span class="csdtag">&lt;CsScore&gt;</span>

<span class="comment">; Table #1: an ordinary sine wave.</span>
<span class="stamnt">f</span> 1 0 32768 10 1

<span class="comment">; p4 = turn the note off (if it is equal to 0).</span>
<span class="comment">; Start playing Instrument #1.</span>
<span class="stamnt">i</span> 1 0 1 1
<span class="comment">; Turn Instrument #1 off after 3 seconds.</span>
<span class="stamnt">i</span> 1 3 1 0
<span class="stamnt">e</span>


<span class="csdtag">&lt;/CsScore&gt;</span>
<span class="csdtag">&lt;/CsoundSynthesizer&gt;</span>
</pre>
          </div>
        </div>
        <p><br class="example-break" />
    </p>
      </div>
      <div class="refsect1">
        <a id="idp115461648"></a>
        <h2>See Also</h2>
        <p>
      <a class="link" href="i.html" title="i Statement (Instrument or Note Statement)"><em class="citetitle">i Statement</em></a>, <a class="link" href="turnoff.html" title="turnoff"><em class="citetitle">turnoff</em></a>
    </p>
      </div>
      <div class="refsect1">
        <a id="idp115464656"></a>
        <h2>Credits</h2>
        <p>Example written by Kevin Conder.</p>
      </div>
    </div>
    <div class="navfooter">
      <hr />
      <table width="100%" summary="Navigation footer">
        <tr>
          <td width="40%" align="left"><a accesskey="p" href="igoto.html">Prev</a> </td>
          <td width="20%" align="center">
            <a accesskey="u" href="OpcodesTop.html">Up</a>
          </td>
          <td width="40%" align="right"> <a accesskey="n" href="imagecreate.html">Next</a></td>
        </tr>
        <tr>
          <td width="40%" align="left" valign="top">igoto </td>
          <td width="20%" align="center">
            <a accesskey="h" href="index.html">Home</a>
          </td>
          <td width="40%" align="right" valign="top"> imagecreate</td>
        </tr>
      </table>
    </div>
  </body>
</html>
